<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/struc/detail/msg_mdt_out.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_58e412aa7ace8e71fc01678dc8765e7c.html">transport</a></li><li class="navelem"><a class="el" href="dir_a98fddea045b8b2df4350ebb1d483bf8.html">struc</a></li><li class="navelem"><a class="el" href="dir_aecdbd335f54ba819e11c976e79836b9.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">msg_mdt_out.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="msg__mdt__out_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Structured Transport</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2023 Akamai Technologies, Inc.; and other contributors.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Each commit is copyright by its respective author or author&#39;s employer.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Licensed under the MIT License:</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * THE SOFTWARE. */</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"></span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="msg_8hpp.html">ipc/transport/struc/msg.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;ipc/transport/struc/schema/detail/structured_msg.capnp.h&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &lt;boost/endian.hpp&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1struc.html">ipc::transport::struc</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"></span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">/**</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * Internally used (data-free) addendum on-top of Msg_out; really an alias</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * to `Msg_out&lt;schema::detail::StructuredMessage&gt;`, where the latter is the internal-use</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * set of metadata schema, with a convenience public mutating API wrapping around capnp-generated mutator API</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * for things like message ID.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * @see Msg_in whose `public` + `protected` API = essentially the accessor counterpart of</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *      Msg_mdt_out and Msg_out&lt;Message_body&gt; mutator APIs.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * @tparam Struct_builder_config</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *         See struc::Channel.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> */</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct_builder_config&gt;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html">   50</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html">Msg_mdt_out</a> :</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>  <span class="keyword">private</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Msg__out.html">Msg_out</a>&lt;schema::detail::StructuredMessage, typename Struct_builder_config::Builder&gt;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>{</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"></span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">  /// Our base class.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a4a497bd79840cf84848ec8512ae0426b">   57</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Msg__out.html">Base</a> = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Msg__out.html">Msg_out&lt;schema::detail::StructuredMessage, typename Struct_builder_config::Builder&gt;</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"></span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">  /// Short-hand for capnp-generated mutating `Builder` nested class of #Body.  See body_root().</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a49dd99dd16346904de43a7af3dbf5379">   60</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a49dd99dd16346904de43a7af3dbf5379">Body_builder</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__out.html#a68188b480ac3c33676b08dce72d92922">Base::Body_builder</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"></span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">  /// Short-hand for user-specified builder engine.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a66ddbd3c8d0a3512e60a214af6fb4713">   66</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a66ddbd3c8d0a3512e60a214af6fb4713">Builder_config</a> = Struct_builder_config;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"></span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">   * In the event `*this` describes an internally-created message -- for internal purposes, not by the user --</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   * this is the equivalent of `Base::Body_builder` for the internal-message schema.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * Refer to structured_msg.capnp for clarity; you&#39;ll see a field there that stores either</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * an `InternalMessageBody` or null.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   */</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a8b0d864f297026952728c9bf5f90cb19">   74</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a8b0d864f297026952728c9bf5f90cb19">Internal_msg_body_builder</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">Base::Body::InternalMessageBody::Builder</a>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"></span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   * Constructs out-metadata-message describing a user-created message (not an internal message);</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   * or else both describing and containing an internal message (no user-created message associated).</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   *</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * @param struct_builder_config</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   *        See other ctor.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * @param session_token</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   *        See other ctor.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * @param originating_msg_id_or_none</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *        0 if the message is unsolicited; else the message ID of the out-message to which this</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   *        is responding.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   * @param id_or_none</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   *        Out-message ID; 0 if internal message.</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   * @param n_serialization_segments_or_none</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   *        # of segments serializing the user-created message described by `*this`; ignored</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   *        if `id_or_none == 0`.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   */</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a09b3e80aab955fbe367b8ebdf0fab792">Msg_mdt_out</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a66ddbd3c8d0a3512e60a214af6fb4713">Builder_config</a>&amp; struct_builder_config,</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>                       <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a6751c05fb6582a34c7c47ac470c4a48b">Session_token</a>&amp; session_token, <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#af7f35fc7588d97a838274fa25700ead9">msg_id_t</a> originating_msg_id_or_none, <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#af7f35fc7588d97a838274fa25700ead9">msg_id_t</a> id_or_none,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>                       <span class="keywordtype">size_t</span> n_serialization_segments_or_none);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"></span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * Returns a builder for the internal-message root; to be called only if `id_or_none == 0` in ctor.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   * (Behavior undefined/assertion may trip otherwise.)  See #Internal_msg_body_builder doc header.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   *</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   * We could return a pointer to something stored, but as of this writing such an optimization would</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   * be pointless, as it&#39;s really invoked just once in practice.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   *</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   */</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a8b0d864f297026952728c9bf5f90cb19">Internal_msg_body_builder</a> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a1541fa2c6343cbcddf3feac9fcf67c46">internal_msg_body_root</a>();</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"></span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * Forwards to Msg_out::body_root() (`const` overload).  May be useful for, say, pretty-printing it</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * to log (e.g.: `capnp::prettyPrint(M.body_root()-&gt;asReader()).flatten().cStr()`).</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   *</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   */</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a49dd99dd16346904de43a7af3dbf5379">Body_builder</a>* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a4dae089f324bbdf98d838ddc70abdc9e">body_root</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"></span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * Returns the serialization in the form of a sequence of 1 `Blob`.  Behavior is undefined if it is called</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * more than once.  (In reality it&#39;s probably fine, but this internal type and its API aren&#39;t meant for that,</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * so it&#39;s easier to just say that and not worry about it.)</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   *</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   * ### Wait, why 1 Blob? ###</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * This is an internal-use structure, and we&#39;ve ensured &quot;heuristically&quot; it&#39;ll fit in any reasonable segment.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   *</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  See Msg_out::emit_serialization()</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   *        which is the core of this guy here.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   * @param session</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   *        Specifies the opposing recipient for which the serialization is intended.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   *        See Msg_out::emit_serialization() which is the core of this guy here.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   * @return What Msg_out::emit_serialization() would have placed in the target list container; or null if</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">   *         it would have failed.  In case of success:</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">   *         In our case that container must have size 1, so we just return that first element.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   */</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>  flow::util::Blob* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a267d8cad7e43fa969c09ae44cf7bafec">emit_serialization</a>(<span class="keyword">const</span> <span class="keyword">typename</span> Base::Builder::Session&amp; session, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>}; <span class="comment">// class Msg_mdt_out</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct_builder_config&gt;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a09b3e80aab955fbe367b8ebdf0fab792">  144</a></span><a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a09b3e80aab955fbe367b8ebdf0fab792">Msg_mdt_out&lt;Struct_builder_config&gt;::Msg_mdt_out</a></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>  (<span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a66ddbd3c8d0a3512e60a214af6fb4713">Builder_config</a>&amp; struct_builder_config, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a6751c05fb6582a34c7c47ac470c4a48b">Session_token</a>&amp; session_token,</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>   <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#af7f35fc7588d97a838274fa25700ead9">msg_id_t</a> originating_msg_id_or_none, <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#af7f35fc7588d97a838274fa25700ead9">msg_id_t</a> id_or_none, <span class="keywordtype">size_t</span> n_serialization_segments_or_none) :</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Msg__out.html">Base</a>(struct_builder_config)</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>{</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>  <span class="keyword">using </span>boost::endian::native_to_little;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  <span class="keyword">const</span> <span class="keyword">auto</span> msg_root = <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__out.html#a9894ad7ec2a46641c4b9b86664d0d465">Base::body_root</a>();</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>  <span class="comment">/* Refer to structured_msg.capnp StructuredMessage.  Base has initialized it for us.  Now to fill it in:</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   * It is *now* serialization/send time, so we fill in everything.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * Let&#39;s go over it:</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   *   - authHeader.sessionToken: We set it here.</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   *   - id: It is used as a sequence #.  We set it here; it may be zero indicating internal message.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   *   - originatingMessageOrNull: Used if and only if this is a response to a past incoming message.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   *     We set it here if so directed.</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   *   - internalMessageBody: Similarly we initialize it if so directed.  It&#39;s not dependent on any template params</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   *     BTW. */</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span> </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>  <span class="comment">// Deal with sessionToken.  Encode as mandated in .capnp Uuid doc header.  @todo Factor this out into a util method.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>  <span class="keyword">auto</span> capnp_uuid = msg_root-&gt;initAuthHeader().initSessionToken();</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>  <span class="keyword">static_assert</span>(std::remove_reference_t&lt;<span class="keyword">decltype</span>(session_token)&gt;::static_size() == 2 * <span class="keyword">sizeof</span>(uint64_t),</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>                <span class="stringliteral">&quot;World is broken: UUIDs expected to be 16 bytes!&quot;</span>);</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>  <span class="keyword">auto</span>&amp; first8 = *(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>uint64_t*<span class="keyword">&gt;</span>(session_token.data())); <span class="comment">// capnp_uuid is aligned, so this is too.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>  <span class="keyword">auto</span>&amp; last8 = *(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>uint64_t*<span class="keyword">&gt;</span>(session_token.data() + <span class="keyword">sizeof</span>(uint64_t))); <span class="comment">// As is this.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>  capnp_uuid.setFirst8(native_to_little(first8)); <span class="comment">// Reminder: Likely no-op + copy of uint64_t.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>  capnp_uuid.setLast8(native_to_little(last8)); <span class="comment">// Ditto.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span> </div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>  msg_root-&gt;setId(id_or_none);</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>  <span class="keywordflow">if</span> (originating_msg_id_or_none != 0)</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>  {</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>    msg_root-&gt;initOriginatingMessageOrNull().setId(originating_msg_id_or_none);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>  }</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>  <span class="keywordflow">if</span> (id_or_none == 0)</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>  {</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>    msg_root-&gt;initInternalMessageBody();</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  }</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>  {</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>    assert((n_serialization_segments_or_none != 0)</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>            &amp;&amp; <span class="stringliteral">&quot;If serializing a user message, you have to have some segs for it.&quot;</span>);</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>    msg_root-&gt;setNumBodySerializationSegments(n_serialization_segments_or_none);</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>  }</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>} <span class="comment">// Msg_mdt_out::Msg_mdt_out()</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct_builder_config&gt;</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a8b0d864f297026952728c9bf5f90cb19">Msg_mdt_out&lt;Struct_builder_config&gt;::Internal_msg_body_builder</a></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a1541fa2c6343cbcddf3feac9fcf67c46">  194</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a1541fa2c6343cbcddf3feac9fcf67c46">Msg_mdt_out&lt;Struct_builder_config&gt;::internal_msg_body_root</a>()</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>{</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>  <span class="keywordflow">return</span> Base::body_root()-&gt;getInternalMessageBody();</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>}</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct_builder_config&gt;</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="keyword">const</span> <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a49dd99dd16346904de43a7af3dbf5379">Msg_mdt_out&lt;Struct_builder_config&gt;::Body_builder</a>*</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a4dae089f324bbdf98d838ddc70abdc9e">  201</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a4dae089f324bbdf98d838ddc70abdc9e">Msg_mdt_out&lt;Struct_builder_config&gt;::body_root</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>  <span class="keywordflow">return</span> Base::body_root();</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>}</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct_builder_config&gt;</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a267d8cad7e43fa969c09ae44cf7bafec">  207</a></span>flow::util::Blob* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a267d8cad7e43fa969c09ae44cf7bafec">Msg_mdt_out&lt;Struct_builder_config&gt;::emit_serialization</a>(<span class="keyword">const</span> <span class="keyword">typename</span> Base::Builder::Session&amp; session,</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span>                                                                         <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)<span class="keyword"> const</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span>  <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">Segment_ptrs</a> target_blobs;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span> </div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span>  Base::emit_serialization(&amp;target_blobs, session, err_code); <span class="comment">// Throws &lt;=&gt; err_code is null *and* serialization failed.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span> </div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>  <span class="comment">// If got here, either no error; or there is an error, and err_code is not null, and *err_code is truthy (the error).</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span>  <span class="keywordflow">if</span> (err_code &amp;&amp; *err_code)</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>  {</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span>    <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span>  }</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span>  <span class="comment">// No error.  err_code is null, or *err_code is falsy.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span> </div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>  assert((!target_blobs.empty()) &amp;&amp; <span class="stringliteral">&quot;That is just weird.&quot;</span>);</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>  assert((target_blobs.size() == 1) &amp;&amp; <span class="stringliteral">&quot;As described in our contract we should have ensured this internal-use &quot;</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>                                         <span class="stringliteral">&quot;structure shall fit in one segment no matter the builder.  Bug?&quot;</span>);</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span>  <span class="keywordflow">return</span> target_blobs.front();</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>}</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span> </div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>} <span class="comment">// namespace ipc::transport::struc</span></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html">ipc::transport::struc::Msg_mdt_out</a></div><div class="ttdoc">Internally used (data-free) addendum on-top of Msg_out; really an alias to Msg_out&lt;schema::detail::St...</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00050">msg_mdt_out.hpp:52</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a09b3e80aab955fbe367b8ebdf0fab792"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a09b3e80aab955fbe367b8ebdf0fab792">ipc::transport::struc::Msg_mdt_out::Msg_mdt_out</a></div><div class="ttdeci">Msg_mdt_out(const Builder_config &amp;struct_builder_config, const Session_token &amp;session_token, msg_id_t originating_msg_id_or_none, msg_id_t id_or_none, size_t n_serialization_segments_or_none)</div><div class="ttdoc">Constructs out-metadata-message describing a user-created message (not an internal message); or else ...</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00144">msg_mdt_out.hpp:145</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a1541fa2c6343cbcddf3feac9fcf67c46"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a1541fa2c6343cbcddf3feac9fcf67c46">ipc::transport::struc::Msg_mdt_out::internal_msg_body_root</a></div><div class="ttdeci">Internal_msg_body_builder internal_msg_body_root()</div><div class="ttdoc">Returns a builder for the internal-message root; to be called only if id_or_none == 0 in ctor.</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00194">msg_mdt_out.hpp:194</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a267d8cad7e43fa969c09ae44cf7bafec"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a267d8cad7e43fa969c09ae44cf7bafec">ipc::transport::struc::Msg_mdt_out::emit_serialization</a></div><div class="ttdeci">flow::util::Blob * emit_serialization(const typename Base::Builder::Session &amp;session, Error_code *err_code) const</div><div class="ttdoc">Returns the serialization in the form of a sequence of 1 Blob.</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00207">msg_mdt_out.hpp:207</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a49dd99dd16346904de43a7af3dbf5379"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a49dd99dd16346904de43a7af3dbf5379">ipc::transport::struc::Msg_mdt_out::Body_builder</a></div><div class="ttdeci">typename Base::Body_builder Body_builder</div><div class="ttdoc">Short-hand for capnp-generated mutating Builder nested class of Body. See body_root().</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00060">msg_mdt_out.hpp:60</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a4dae089f324bbdf98d838ddc70abdc9e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a4dae089f324bbdf98d838ddc70abdc9e">ipc::transport::struc::Msg_mdt_out::body_root</a></div><div class="ttdeci">const Body_builder * body_root() const</div><div class="ttdoc">Forwards to Msg_out::body_root() (const overload).</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00201">msg_mdt_out.hpp:201</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a66ddbd3c8d0a3512e60a214af6fb4713"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a66ddbd3c8d0a3512e60a214af6fb4713">ipc::transport::struc::Msg_mdt_out::Builder_config</a></div><div class="ttdeci">Struct_builder_config Builder_config</div><div class="ttdoc">Short-hand for user-specified builder engine.</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00066">msg_mdt_out.hpp:66</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__mdt__out_html_a8b0d864f297026952728c9bf5f90cb19"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__mdt__out.html#a8b0d864f297026952728c9bf5f90cb19">ipc::transport::struc::Msg_mdt_out::Internal_msg_body_builder</a></div><div class="ttdeci">typename Base::Body::InternalMessageBody::Builder Internal_msg_body_builder</div><div class="ttdoc">In the event *this describes an internally-created message – for internal purposes,...</div><div class="ttdef"><b>Definition:</b> <a href="msg__mdt__out_8hpp_source.html#l00074">msg_mdt_out.hpp:74</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__out_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__out.html">ipc::transport::struc::Msg_out</a></div><div class="ttdoc">A structured out-message suitable to be sent via struc::Channel::send() (et al).</div><div class="ttdef"><b>Definition:</b> <a href="msg_8hpp_source.html#l00153">msg.hpp:154</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__out_html_a68188b480ac3c33676b08dce72d92922"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__out.html#a68188b480ac3c33676b08dce72d92922">ipc::transport::struc::Msg_out::Body_builder</a></div><div class="ttdeci">typename Body::Builder Body_builder</div><div class="ttdoc">Short-hand for capnp-generated mutating Builder nested class of Body. See body_root().</div><div class="ttdef"><b>Definition:</b> <a href="msg_8hpp_source.html#l00162">msg.hpp:162</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Msg__out_html_a9894ad7ec2a46641c4b9b86664d0d465"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Msg__out.html#a9894ad7ec2a46641c4b9b86664d0d465">ipc::transport::struc::Msg_out::body_root</a></div><div class="ttdeci">Body_builder * body_root()</div><div class="ttdoc">The Body root capnp-generated mutator object.</div><div class="ttdef"><b>Definition:</b> <a href="msg_8hpp_source.html#l01018">msg.hpp:1018</a></div></div>
<div class="ttc" id="amsg_8hpp_html"><div class="ttname"><a href="msg_8hpp.html">msg.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_abfde278018c84aa1542475e9a4089c29"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">ipc::transport::struc::shm::classic::Builder</a></div><div class="ttdeci">Builder&lt; ipc::shm::classic::Pool_arena &gt; Builder</div><div class="ttdoc">Convenience alias: transport::struc::shm::Builder that works with boost.ipc.shm pools from ipc::shm::...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00036">classic_fwd.hpp:36</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html">ipc::transport::struc</a></div><div class="ttdoc">Sub-module of Flow-IPC module ipc::transport providing transmission of structured messages specifical...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8cpp_source.html#l00030">channel.cpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_a6751c05fb6582a34c7c47ac470c4a48b"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#a6751c05fb6582a34c7c47ac470c4a48b">ipc::transport::struc::Session_token</a></div><div class="ttdeci">boost::uuids::uuid Session_token</div><div class="ttdoc">A type used by struc::Channel for internal safety/security/auth needs.</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00113">struc_fwd.hpp:113</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_a82a69eaa39cbe8a002de1266f1cbb5cb"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">ipc::transport::struc::Segment_ptrs</a></div><div class="ttdeci">std::vector&lt; flow::util::Blob * &gt; Segment_ptrs</div><div class="ttdoc">Sequence of 1+ Blob pointers to blobs which must stay alive while these pointers may be dereferenced,...</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00122">struc_fwd.hpp:122</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_af7f35fc7588d97a838274fa25700ead9"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#af7f35fc7588d97a838274fa25700ead9">ipc::transport::struc::msg_id_t</a></div><div class="ttdeci">uint64_t msg_id_t</div><div class="ttdoc">Message ID uniquely identifying outgoing message (Msg_out, among all other Msg_outs),...</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00145">struc_fwd.hpp:145</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
